MarkLogic 12 Product Documentation
GET /manage/v2/roles/{id|name}/properties

Summary

This resource address returns the properties of the specified role.

URL Parameters
format The format of the returned data. Can be either json or xml (default). This value overrides the Accept header if both are present.
Request Headers
Accept The expected MIME type of the response. If the format parameter is present, it takes precedence over the Accept header.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges. A status code of 404 (no such user) is returned if the user does not exist.

Required Privileges

This operation requires one of the following:

Usage Notes

The structure of the output returned from this REST API is as follows:

role-name

The Role name (unique)

description

An object's description.

compartment

The compartment that this role is part of.

external-names

The external names specifications.

This is a complex structure with the following children:

external-name

The name used to match external group name.

roles

The roles assigned. The roles assigned to the user.

This is a complex structure with the following children:

role

A role identifier (unique key).

permissions

The default set of permissions used in document creation.

This is a complex structure with the following children:

permission

Permission representation.

This is a complex structure with the following children:

role-name

The Role name (unique)

capability

The action/task permitted by a permission

privileges

A list of privileges.

This is a complex structure with the following children:

privilege

A privilege.

This is a complex structure with the following children:

privilege-name

Privilege name (unique)

action

A URI to protect.

kind

A protected "action" (or object).

collections

The default set of collections used in document creation.

This is a complex structure with the following children:

collection

The collection uri.

queries

This is a complex structure with the following children:

capability-query

This is a complex structure with the following children:

capability

The action/task permitted by a permission

query

This is a complex structure with the following children:

cts:query

Example


http://localhost:8002/manage/v2/roles/engineer/properties

==> Returns the properties of the role, "engineer," from the Security database.

Example


curl -X GET -i --digest -u admin:admin -H "Accept: application/xml" \
http://localhost:8002/manage/v2/roles/region-EMEA/properties

<role-properties xmlns="http://marklogic.com/manage">
  <role-name>region-EMEA</role-name>
  <description>Can see region EMEA documents.</description>
  <compartment>compartment-region</compartment>
  <queries>
    <capability-query>
      <capability>read</capability>
      <query>
	<cts:element-query xmlns:cts="http://marklogic.com/cts">
	  <cts:element>metadata</cts:element>
	  <cts:element-word-query>
	    <cts:element>region</cts:element>
	    <cts:text xml:lang="en">EMEA</cts:text>
	  </cts:element-word-query>
	</cts:element-query>
      </query>
    </capability-query>
  </queries>
</role-properties>

==> Returns the properties of a role, named "region-EMEA", with role queries for "read",
from the Security database.
Powered by MarkLogic Server | Terms of Use | Privacy Policy